home *** CD-ROM | disk | FTP | other *** search
/ Giga Games 1 / Giga Games.iso / net / hack / 3_1_3 / sys / winnt / install.nt next >
Encoding:
Text File  |  1993-07-01  |  10.8 KB  |  247 lines
  1.     Copyright (c) NetHack PC Development Team 1990 - 1993.
  2.     NetHack may be freely redistributed.  See license for details.
  3.         ======================================================
  4.         Instructions for compiling and installing
  5.          NetHack 3.1 on a Windows NT system
  6.         ======================================================
  7.          (or, How to make NT NetHack 3.1.3)
  8.             Last revision: Jun 30, 1993
  9.  
  10. Credit for the PC versions of NetHack goes to the PC Development team 
  11. consisting of Norm Meluch, Kevin Smolkowski, Paul Winner and Steve 
  12. VanDevender who built on the work of Pierre Martineau, Stephen Spackman, 
  13. Steve Creps, Mike Threepoint and Don Kneller.  
  14.  
  15. Credit for the porting of NetHack to Windows NT goes to the NT Porting 
  16. Team started by Michael Allison.
  17.  
  18. The NT porting team also wishes to thank the following people for
  19. their help, testing effort, and suggestions which contributed to the 
  20. completion of the first Windows NT port of NetHack: Doug Thompson, 
  21. Phil Mills, Scott Murray. 
  22.  
  23. This current version of NetHack for Windows NT is a tty port utilizing 
  24. the NT WIN32 Console I/O subsystem.
  25.  
  26.  
  27. I.  Dispelling the Myths:
  28.  
  29.     Compiling NetHack is not as easy as it sounds, nor as hard as it looks,
  30.     however it will behoove you to read this entire file through before
  31.     beginning the task.
  32.  
  33.     We have provided the proper makefiles for building NetHack using the
  34.     following compilers:
  35.  
  36.     Microsoft Windows NT March 1993 SDK C Compiler.
  37.  
  38.     All the makefiles were created for use with MS NMAKE which
  39.     is provided with the Windows NT SDK (Software Development Kit).
  40.  
  41.     You may find it useful to obtain copies of lex (flex) and yacc (bison).
  42.     While not strictly necessary to compile nethack, they are required should
  43.     you desire to make any changes to the level and dungeon compilers.
  44.     Flex and Yacc for NT are available in the "Porting from UNIX to
  45.     NT" library on the MSWIN32 Forum on compuserve and other places.
  46.  
  47.     To use the distributed NetHack icon, a version of uudecode is required,
  48.     but this is not a necessary step for compiling NT NetHack.
  49.  
  50. II. To compile your copy of NetHack on a Windows NT machine:
  51.     (or "just follow these few 'simple' steps outlined below.")
  52.  
  53. Setting Up
  54.  
  55. 1.  It almost goes without saying that you should make sure that your tools
  56.     are set up and running correctly.
  57.  
  58. 2.  Make sure all the NetHack files are in the appropriate directory
  59.     structure.  You should have a main directory with subdirectories
  60.     dat, doc, include, src, sys\share, sys\winnt, util and win\tty.
  61.     Other subdirectories may also be included in your distribution, but
  62.     they are not necessary for use with NT.  You can delete them
  63.     to save space.
  64.  
  65.     Required Directories for NT:
  66.  
  67.                             top
  68.                              |
  69.         -------------------------------------------- 
  70.         |       |     |        |       |     |     | 
  71.        util    dat   doc    include   src   sys   win
  72.                                              |     |
  73.                                           ------   ---- 
  74.                                           |    |      | 
  75.                                        share  winnt  tty
  76.  
  77.  
  78.     Check the file "Files" in your top level directory for an exact
  79.     listing of what file is in which directory.  In order for the
  80.     Makefiles to work, all the source files must be in the proper
  81.     locations.
  82.  
  83.     If you downloaded or ftp'd the sources from a UNIX system, the lines
  84.     will probably end in UNIX-style newlines, instead of the carriage
  85.     return and line feed pairs used by DOS.  Some programs have trouble
  86.     with them, so you may need to convert them (with a utility like
  87.     Rahul Dhesi's "flip").  Also, every file should end with an empty
  88.     line, because Microsoft C has a habit of ignoring the
  89.     last line of each file. 
  90.  
  91. 3.  Go to the sys\winnt directory and run the setup.bat batch file.
  92.     The necessary Makefile movements will be accomplished for you. It
  93.     will also verify that your directories are set up properly.
  94.  
  95. 4.  Now go to the include subdirectory to check a couple of the header
  96.     files there.  Things *should* work as they are, but since you have
  97.     probably set up your system in some sort of custom configuration
  98.     it doesn't hurt to check out the following:
  99.  
  100.     First check config.h according to the comments to match your system and
  101.     desired set of features.  Mostly you need to check the WIZARD option,
  102.     make sure the HACKDIR is set properly.
  103.  
  104.     Also check COMPRESS.
  105.  
  106.     You may include all or as few of the special game features as you wish.
  107.  
  108.     Also check ntconf.h, which should not need much editing. It is there that
  109.     you may choose to enable color text character support by leaving
  110.     TERMCOLOR uncommented, or disable color support by commenting out 
  111.     TERMCOLOR.
  112.  
  113. 5.  If you want to change the high score list behavior, examine the top of
  114.     topten.c, in the src directory.  You may want to change the definitions of
  115.     PERSMAX, POINTSMIN, and ENTRYMAX.  I set POINTSMIN to 51 and ENTRYMAX to
  116.     50 to keep the size of the score list down.
  117.  
  118. 6.  Go to the src directory and edit the top of your Makefile.
  119.     Change the setting of (GAMEDIR) to reflect the directory where
  120.     you want NetHack to be installed.  
  121.  
  122.     ie.  GAMEDIR = \games\nethack
  123.  
  124.     The directory you specify *MUST* exist for all remaining steps to be 
  125.     successful. Be sure the directory you want the game installed 
  126.     actually exists.  If it doesn't, create it now.
  127.  
  128.     If you elected not to use the high-quality BSD random number routines by
  129.     commenting out RANDOM in ntconf.h, comment out (or set equal
  130.     to nothing) the RANDOM macro in your Makefile.
  131.  
  132.     If you want, you can choose to have a default NetHack ICON embedded
  133.     into your executable. You must have first uudecoded the file
  134.     sys\winnt\nhico.uu into sys\winnt\nethack.ico.
  135.     Change the Makefile macro RESFILE to point to the second
  136.     choice (make the macro specify the .rbj file, rather than being set
  137.     equal to nothing).
  138.  
  139.     If you are recompiling after patching your sources, or if you got your
  140.     files from somewhere other than the official distribution, "touch
  141.     makedefs.c" to ensure that certain files (onames.h and pm.h) are remade,
  142.     lest potentially troublesome timestamps fool "nmake".
  143.  
  144. Compiling
  145.  
  146. 7.  Now that everything is set up, go to the util directory and
  147.     run nmake.  If you get any errors along the way then something
  148.     has not been set up correctly.
  149.  
  150. 8.  Next, go to the dat directory and run nmake (just as you did for util).
  151.     Once again, if you get any errors then something has not been 
  152.     set up correctly.
  153.  
  154. 9.  Finally, go to the src directory and "nmake install".  The time it takes
  155.     to compile depends on your particular machine of course, but you should 
  156.     be able to go for lunch and return to find everything finished.  The 
  157.     less memory, and slower your machine, the longer the lunch you may take.
  158.     
  159.     In any case, it is likely that the command prompt window where you are 
  160.     doing the compiling will be occupied for a quite a while.  If all 
  161.     goes well, you will get an NetHack executable.
  162.  
  163. Running NetHack
  164.  
  165. 10. Make sure the support files -- data, rumors, cmdhelp, opthelp, help, hh,
  166.     history, options and license -- were copied to the game directory.  If not,
  167.     move them there from the dat directory yourself.  
  168.     Assuming you are still in the src,dat, or util directory,
  169.     "rumors." can be created manually by entering "..\util\makedefs -r"
  170.     "data." can be created by entering "..\util\makedefs -d".
  171.  
  172.     Make sure the file NetHack.cnf made it to your game directory.
  173.     If not, go to sys\winnt and copy winnt.cnf to NetHack.cnf in 
  174.     your game directory.  Edit NetHack.cnf to reflect your
  175.     particular setup and personal preferences, by following the comments.
  176.   
  177. Running from Command Prompt
  178.  
  179. 11. If you are running it from the command prompt, you must first set the
  180.     HACKDIR environment variable to the location where the nethack 
  181.     executable resides:
  182.  
  183.     set HACKDIR=c:\games\nethack)
  184.     (or whatever drive and directory you want to use)
  185.  
  186.     You should also add the directory containing the NetHack executable
  187.     to your PATH, so that you can just type "nethack" or "nethack -umike"
  188.     to start it up.  Alternatively, you can explicitly invoke it with 
  189.     "c:\games\nethack\nethack" (specifying whatever drive and directory your
  190.     executable resides in) each time.
  191.  
  192.  
  193. Running from Windows NT Program Manager
  194.  
  195. 12. If you will be running it by launching it from the Program Manager,
  196.     be sure to specify the location of your NetHack executable in the 
  197.     "Working Directory:" dialogue box field when creating your 
  198.     Program Manager Icon:
  199.  
  200.     ie.  Description      :  NetHack 3.1.3 
  201.          Command Line     :  C:\GAMES\NETHACK\NETHACK.EXE
  202.          Working Directory:  C:\GAMES\NETHACK
  203.          Shortcut key     :
  204.  
  205. 13. If you did not elect to embed an ICON into the NetHack executable
  206.     when you built it, then you may point the program manager to the 
  207.     ICON of your choice using the program manager (f)ile, (p)roperties,
  208.     change icon option.
  209.  
  210.     A NetHack icon has been provided in the file SYS\WINNT\NHICO.UU.
  211.     This is a uuencoded copy of the icon file, and you must use uudecode
  212.     to turn it into a Windows NT icon file, in order to use the icon.
  213.  
  214. 14. Play NetHack.  If it works, you're done!
  215.  
  216. Notes:
  217.  
  218. 1)  To install an update of NetHack after changing something, enter "nmake"
  219.     from the src directory.  If you add, delete, or reorder monsters or
  220.     objects, or you change the format of saved level files, delete any save
  221.     and bones files.  (Trying to use such files sometimes produces amusing
  222.     confusions on the game's part, but usually crashes.)
  223.  
  224.     If you made changes to any of the level compiler software, you may have
  225.     to delete dgn_flex.c, dgn_yacc.c, lev_flex.c, and lev_yacc.c from the
  226.     util directory to ensure that they are remade.
  227.  
  228. 2)  The executable produced by this port is a 32-bit, flat-address space, 
  229.     non-overlayed .exe file, which should run on any Windows NT system. 
  230.     It is also a rather large file:
  231.  
  232.     More than 1,900,000 bytes, nethack.exe when debugging information 
  233.         is included in the .exe, and more than 1,200,000 bytes without.
  234.  
  235. 3)  Beginning with NetHack 3.1.3, the keyboard command sequences match
  236.     those in the MSDOS port of NetHack more exactly.  The keypad may be used for
  237.     movement without having the NUMLOCK on.  This also gives you the advantage
  238.     of being able to RUN by pressing the SHIFT key at the same time as one
  239.     of the directional movement keys on the keypad (1,2,3,4,6,7,8,9).
  240.  
  241. 4)  A true Windows (WIN32s) version of NetHack is currently under development
  242.     by the PC Windows Porting team.
  243.  
  244. 5)  If you have comments or suggestions, feel free to drop any one of
  245.     us a line c/o nethack-bugs@linc.cis.upenn.edu.  From compuserve,
  246.     try  >INTERNET:nethack-bugs@linc.cis.upenn.edu.
  247.